Skip to content

[dashboard as code] dashboard client #241393

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 24 commits into from
Nov 4, 2025
Merged

[dashboard as code] dashboard client #241393

merged 24 commits into from
Nov 4, 2025

Conversation

@nreese
Copy link
Contributor

@nreese nreese commented Oct 31, 2025 •
edited
Loading

Part of #238500

PR consolidates HTTP requests into dashboardClient. get and delete are migrated to REST endpoints while create, search, and update are labeled with TODOs. Those endpoints need some work before dashboard can use them.

@nreese nreese mentioned this pull request Oct 31, 2025
Closed
@nreese
Copy link
Contributor Author

nreese commented Oct 31, 2025

/ci

@nreese
Copy link
Contributor Author

nreese commented Oct 31, 2025

/ci

@nreese
Copy link
Contributor Author

nreese commented Oct 31, 2025

/ci

@nreese
Copy link
Contributor Author

nreese commented Oct 31, 2025

/ci

@nreese
Copy link
Contributor Author

nreese commented Oct 31, 2025

/ci

@nreese
Copy link
Contributor Author

nreese commented Oct 31, 2025

/ci

@nreese
Copy link
Contributor Author

nreese commented Oct 31, 2025

/ci

@elasticmachine
Copy link
Contributor

elasticmachine commented Oct 31, 2025

💛 Build succeeded, but was flaky

Failed CI Steps

Test Failures

  • [job] [logs] FTR Configs #95 / Rules Management - Rule creation APIs @serverless @ess @serverlessQA create_rules @skipInServerless missing timestamps generates two signals with a "partial failure" status

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id before after diff
dashboard 698 695 -3

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id before after diff
dashboard 88 87 -1

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id before after diff
dashboard 658.4KB 656.6KB -1.9KB

Public APIs missing exports

Total count of every type that is part of your API that should be exported but is not. This will cause broken links in the API documentation system. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats exports for more detailed information.

id before after diff
dashboard 11 10 -1

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id before after diff
dashboard 18.1KB 18.0KB -108.0B
dashboardEnhanced 11.5KB 11.4KB -54.0B
total -162.0B

History

@nreese nreese marked this pull request as ready for review November 1, 2025 16:46
@nreese nreese requested a review from a team as a code owner November 1, 2025 16:46
@nreese nreese added Team:Presentation Presentation Team for Dashboard, Input Controls, and Canvas t// release_note:skip Skip the PR/issue when compiling release notes backport:skip This PR does not require backporting Project:Dashboards API v9.3.0 labels Nov 1, 2025
@elasticmachine
Copy link
Contributor

elasticmachine commented Nov 1, 2025

Pinging @elastic/kibana-presentation (Team:Presentation)

@nickpeihl nickpeihl self-requested a review November 3, 2025 13:04
@nreese
Copy link
Contributor Author

nreese commented Nov 3, 2025

@elasticmachine merge upstream

@botelastic botelastic bot added the Feature:Drilldowns Embeddable panel Drilldowns label Nov 3, 2025
nickpeihl
nickpeihl approved these changes Nov 3, 2025
View reviewed changes
Copy link
Member

@nickpeihl nickpeihl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm! nice cleanup and a clean, simple PR for reviewing. code review and tested dashboard client methods.

src/platform/plugins/shared/dashboard/common/content_management/constants.ts
*/

export const LATEST_VERSION = 1;
export const DASHBOARD_API_VERSION = String(LATEST_VERSION);
Copy link
Member

@nickpeihl nickpeihl Nov 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think there's anything we need to do here right now, but it's coincidental that the LATEST_VERSION used by Content Management and the DASHBOARD_API_VERSION for the pubic API are both 1. I suspect we'll be removing CM from the Dashboard in the future and the LATEST_VERSION const will go away. When the Dashboard API reaches Tech Preview, the const will change to 2023-10-31.

Copy link
Contributor Author

@nreese nreese Nov 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why "2023-10-31" What does that date mean?

Copy link
Member

@nickpeihl nickpeihl Nov 3, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's the date-based API versioning scheme that Elastic uses for all public APIs. More info here and restriction implemented here. We just keep it at "1" for now as the endpoint is still internal only.

@nreese
Copy link
Contributor Author

nreese commented Nov 3, 2025

@elasticmachine merge upstream

@nreese
Copy link
Contributor Author

nreese commented Nov 3, 2025

@elasticmachine merge upstream

@nreese nreese enabled auto-merge (squash) November 3, 2025 22:28
@nreese
Copy link
Contributor Author

nreese commented Nov 3, 2025

@elasticmachine merge upstream

@nreese
Copy link
Contributor Author

nreese commented Nov 4, 2025

@elasticmachine merge upstream

@nreese nreese merged commit 5301819 into elastic:main Nov 4, 2025
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@nickpeihl nickpeihl nickpeihl approved these changes

Assignees

No one assigned

Labels

backport:skip This PR does not require backporting Feature:Drilldowns Embeddable panel Drilldowns Project:Dashboards API release_note:skip Skip the PR/issue when compiling release notes Team:Presentation Presentation Team for Dashboard, Input Controls, and Canvas t// v9.3.0

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@nreese @elasticmachine @nickpeihl @kibanamachine